<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>CyberLinkObjc: CGUpnpControlPoint Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">CyberLinkObjc
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a>  </div>
  <div class="headertitle">
<div class="title">CGUpnpControlPoint Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#import &lt;<a class="el" href="_c_g_upnp_control_point_8h_source.html">CGUpnpControlPoint.h</a>&gt;</code></p>

<p><a href="class_c_g_upnp_control_point-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1bff5a9263d6e3e26a9d76dea838ac22"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bff5a9263d6e3e26a9d76dea838ac22"></a>
(CgUpnpControlPoint *)&#160;</td><td class="memItemRight" valign="bottom">- <b>cObject</b></td></tr>
<tr class="memitem:a2fa0d2fe4287bf9e6596d634ae800683"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#a2fa0d2fe4287bf9e6596d634ae800683">start</a></td></tr>
<tr class="memitem:ace4a1a10baa3f893752a9f18b1d24cc5"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#ace4a1a10baa3f893752a9f18b1d24cc5">stop</a></td></tr>
<tr class="memitem:a52e1f9d239f219773ee44275371cad77"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#a52e1f9d239f219773ee44275371cad77">isRunning</a></td></tr>
<tr class="memitem:aa2ecd4b95780704d69b82012edce7672"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#aa2ecd4b95780704d69b82012edce7672">search</a></td></tr>
<tr class="memitem:a766273ced74e85a91375d387ae90150f"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#a766273ced74e85a91375d387ae90150f">searchWithST:</a></td></tr>
<tr class="memitem:a5b4385e5396b29cd66cca675e6bd652b"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#a5b4385e5396b29cd66cca675e6bd652b">setSsdpSearchMX:</a></td></tr>
<tr class="memitem:a4307ef982016c001f7ba065cbe2f04a9"><td class="memItemLeft" align="right" valign="top">(NSInteger)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#a4307ef982016c001f7ba065cbe2f04a9">ssdpSearchMX</a></td></tr>
<tr class="memitem:ae344dfa94337e21f1f1e4bb9c4004fbc"><td class="memItemLeft" align="right" valign="top">(NSArray *)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#ae344dfa94337e21f1f1e4bb9c4004fbc">devices</a></td></tr>
<tr class="memitem:a7547ad1c5da99994b87498e9f845498c"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_c_g_upnp_device.html">CGUpnpDevice</a> *)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_c_g_upnp_control_point.html#a7547ad1c5da99994b87498e9f845498c">deviceForUDN:</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a0ed90a1d7119f833295e540475d56f72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ed90a1d7119f833295e540475d56f72"></a>
CgUpnpControlPoint *&#160;</td><td class="memItemRight" valign="bottom"><b>cObject</b></td></tr>
<tr class="memitem:a5aabce13d286ffdd4d1da4a34e7d552c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5aabce13d286ffdd4d1da4a34e7d552c"></a>
id&lt; <a class="el" href="protocol_c_g_upnp_control_point_delegate-p.html">CGUpnpControlPointDelegate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>delegate</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="interface_c_g_upnp_control_point.html">CGUpnpControlPoint</a> class is a wrapper class for CgUpnpControlPoint of CyberLink for C to program using only Objective-C directly on MacOSX. Currently, the only basic methods are wrapped to control UPnP devices. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7547ad1c5da99994b87498e9f845498c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (<a class="el" href="interface_c_g_upnp_device.html">CGUpnpDevice</a> *) deviceForUDN: </td>
          <td></td>
          <td class="paramtype">(NSString *)&#160;</td>
          <td class="paramname"><em>udn</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get a specified UPnP devices by the UDN. </p>
<dl class="section return"><dt>Returns:</dt><dd><a class="el" href="interface_c_g_upnp_device.html">CGUpnpDevice</a> when the specified device is found, otherwise nil. </dd></dl>

</div>
</div>
<a class="anchor" id="ae344dfa94337e21f1f1e4bb9c4004fbc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (NSArray *) devices </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get all UPnP devices which the control point found as a NSArray object. The array has the devices as instances of <a class="el" href="interface_c_g_upnp_device.html">CGUpnpDevice</a>. </p>
<dl class="section return"><dt>Returns:</dt><dd>NSArray of <a class="el" href="interface_c_g_upnp_device.html">CGUpnpDevice</a>. </dd></dl>

</div>
</div>
<a class="anchor" id="a52e1f9d239f219773ee44275371cad77"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) isRunning </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Check if the controll point is running.</p>
<dl class="section return"><dt>Returns:</dt><dd>YES if the device is started normally, otherwise NO. </dd></dl>

</div>
</div>
<a class="anchor" id="aa2ecd4b95780704d69b82012edce7672"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) search </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Send a M-SEARCH request to find for the all UPnP devices of UPnP in the network. The method waits for the specified MX time. Use <a class="el" href="interface_c_g_upnp_control_point.html#a5b4385e5396b29cd66cca675e6bd652b">setSsdpSearchMX:</a>aMX to change the time. The method is same as searchWithST() when the ST parameter is "ssdp:all". </p>

</div>
</div>
<a class="anchor" id="a766273ced74e85a91375d387ae90150f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) searchWithST: </td>
          <td></td>
          <td class="paramtype">(NSString *)&#160;</td>
          <td class="paramname"><em>aST</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Send a M-SEARCH request to find for the specified UPnP devices by a ST parameter in the network. The method waits for the specified MX time. Use <a class="el" href="interface_c_g_upnp_control_point.html#a5b4385e5396b29cd66cca675e6bd652b">setSsdpSearchMX:</a>aMX to change the time.</p>
<dl class="params"><dt>Parameters:</dt><dd>
  <table class="params">
    <tr><td class="paramname">aST</td><td>The Search Target parameter (ex. "ssdp:all") </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5b4385e5396b29cd66cca675e6bd652b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) setSsdpSearchMX: </td>
          <td></td>
          <td class="paramtype">(NSInteger)&#160;</td>
          <td class="paramname"><em>aMX</em></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set a MX parameter used for SSDP searches in seconds. The parameter is used to wait for M-SEARCH responses in <a class="el" href="interface_c_g_upnp_control_point.html#aa2ecd4b95780704d69b82012edce7672">search</a> and <a class="el" href="interface_c_g_upnp_control_point.html#a766273ced74e85a91375d387ae90150f">searchWithST:</a>aST.</p>
<dl class="params"><dt>Parameters:</dt><dd>
  <table class="params">
    <tr><td class="paramname">aMX</td><td>Time to wait </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a4307ef982016c001f7ba065cbe2f04a9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (NSInteger) ssdpSearchMX </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get a MX parameter used for SSDP searches in seconds. The parameter is used to wait for M-SEARCH responses in <a class="el" href="interface_c_g_upnp_control_point.html#aa2ecd4b95780704d69b82012edce7672">search</a> and <a class="el" href="interface_c_g_upnp_control_point.html#a766273ced74e85a91375d387ae90150f">searchWithST:</a>aST.</p>
<dl class="section return"><dt>Returns:</dt><dd>Time to wait </dd></dl>

</div>
</div>
<a class="anchor" id="a2fa0d2fe4287bf9e6596d634ae800683"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) start </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Activate some background threads of the control point such as SSDP and HTTP servers to listen messages and events of UPnP. You must call this method before you can actually use a control point.</p>
<dl class="section return"><dt>Returns:</dt><dd>TRUE if successful; otherwise FALSE </dd></dl>

</div>
</div>
<a class="anchor" id="ace4a1a10baa3f893752a9f18b1d24cc5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) stop </td>
          <td></td>
          <td class="paramname"></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Stop some background threads of the control point such as SSDP and HTTP servers to listen messages and events of UPnP.</p>
<dl class="section return"><dt>Returns:</dt><dd>TRUE if successful; otherwise FALSE </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_c_g_upnp_control_point_8h_source.html">CGUpnpControlPoint.h</a></li>
<li>CGUpnpControlPoint.m</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 29 2012 07:45:45 for CyberLinkObjc by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
